home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Tampa Bay Amiga Group / TBAG - Tampa Bay Amiga Group's Disk of the Month #34 (1989)(Merlin's Software)(PD).zip / TBAG - Tampa Bay Amiga Group's Disk of the Month #34 (1989)(Merlin's Software)(PD).adf / Doc-Files / XIP.doc < prev    next >
Text File  |  1989-07-22  |  21KB  |  596 lines
  1.     "XIP--Image Presentor",  Copyright 1989,  by Ralph Ciper
  2.  
  3.                           To execute this demo:
  4.    
  5.                    Enter  "XIP XIP.doc"  at the CLI prompt 
  6.                                    -or- 
  7.                      use the "XIP.s" icon from workbench.
  8.   
  9.  
  10.         ******************  Introduction to XIP  *****************
  11.  
  12.                        * * *  Prototype * * *
  13.            
  14.     The "XIP--Image Presentor" has be presented ASIS, with no implied
  15.     or expressed warranties.  Note: the term XIP in this document refers
  16.     to the XIP--Image Presentor program written by Ralph Ciper.  If this
  17.     term is currently used by another product or service, the existence
  18.     was not know and infringement was not intended.
  19.              
  20.     XIP is a computer based presentation system.  Providing an video
  21.     presentation that could be controlled by the easily by a speaker was
  22.     the basis its design.  Control of the images is accomplished by only 
  23.     the mouse buttons and time interval.  Currently the mouse controls
  24.     only forward movement, but later versions will allow the presenter
  25.     to show previously shown images.
  26.     
  27.     Also to keep the audience's attention, XIP produces virtually an
  28.     unlimited number of screen transitions.  These wipes can be from 
  29.     the simple to the quite.  With this feature, XIP is capable of
  30.     producing a spectacular self-running slide-show. 
  31.     
  32.          
  33.     XIP features:
  34.     
  35.        *   Thousands of possible screen transitions.
  36.        
  37.        *   All Amiga IFF ILBM screen formats are handled:
  38.               Hi-res, Lo-res, Med-res, Interlaced, HAM, 
  39.               Half-brite, and over-scan.
  40.               
  41.        *   CLI parameter or Command File control.
  42.               
  43.        *   Windowing.
  44.        
  45.        *   Mouse control.  
  46.  
  47.        *   Double Buffering for make transitions as smooth or
  48.              crisp as desired. 
  49.  
  50.        *   Execute CLI Commands while running.
  51.  
  52.  
  53.         *****************  Registration Info  ********************
  54.         
  55.      If you like this product, please order a registered copy.  The 
  56.      registered copy will include the most enhanced version of XIP 
  57.      available and a printed user guide.  Support the share-ware 
  58.      concept, send a $25 check to register to: 
  59.  
  60.                                Tiffany Ciper
  61.                             14337 Diplomat Dr.
  62.                              Tampa, FL  33613
  63.  
  64.      Please address any questions, comments or suggestions to Ralph Ciper
  65.      at the above address.  I am interested in hearing your thoughts on 
  66.      program, even if do not wish to contribute.  You can also contact
  67.      me through Email on the Tampa Bay Amiga Group (TBAG) BBS 813-977-0941
  68.      in Tampa, Florida or at one of the Group Meetings.     
  69.                      
  70.  
  71.         **********  Files Included in Demo Version  *************
  72.                 
  73.     The following file are include with the archive file.  Which originally
  74.     was posted on PeopleLink and The TBAG BBS.  This copy may be freely
  75.     distributed in its archived form or placed on diskette provided that 
  76.     all the files, except "iff.library", are placed in the same directory.
  77.  
  78.  XIP          The "XIP-Image Presentor" Program
  79.  XIP.doc      XIP documentation.    (also used as a demo command file)
  80. "XIP.1"       Logo Screen 1         (in quotes for XIP to know to display)
  81. "XIP.2"       Logo Screen 2                          ''
  82.  XIP.s        A simple CLI script file 
  83.  XIP.s.info   XICON icon for script
  84.  iff.library  Christian Weber's IFF.library.  Transfer to system library 
  85.               "LIBS:"  volume, if not already present. 
  86.   
  87.                                         
  88.                               
  89.         **************  Sections in This Document  ***************
  90.  
  91.      The following sections are in this document:
  92.       
  93.            Introduction to XIP
  94.            Registration Info
  95.            Files Included with Demo
  96.            Sections in This Document
  97.            Quick Instructions
  98.            Wipe Definition
  99.            Window Definition
  100.            Tiling Definition
  101.            Control Commands
  102.            CLI Command Definitions
  103.            Command File Format
  104.            Distribution
  105.            Command File Demo
  106.  
  107.  
  108.          ****************  Quick Instructions  *******************
  109.   
  110.   The prototype XIP can only be executed only from CLI.  Please use ICONX 
  111.   to execute using an Workbench icon.  XIP.S and XIP.S.INFO are included
  112.   for Workbench users. 
  113.   
  114.   Format:  "XIP command/... "
  115.  
  116.    Where:  <command> is any of the following:
  117.    
  118.            IFF picture (ILBM) filename,   
  119.            XIP control filename, 
  120.            wipe definition, 
  121.            window definition, 
  122.            tiling definition,
  123.            process control command, or
  124.            a CLI command definition.
  125.                        
  126.   Any number of commands can be placed on a single CLI command line.  
  127.   XIP will exit on the first invalid command or filename.    
  128.   If a space in required in any filename or command enclose the entire 
  129.       command in quotation marks ("). 
  130.   See the appropriate section for detail on format of definitions.
  131.                    
  132.  
  133.        
  134.         ******************   Wipe Definitions   ******************
  135.  
  136.     The main power of XIP is the ability to combine wipes to form
  137.     an unlimited number of screen transitions.  A wipe definition 
  138.     is noted by starting with the symbol "@" then a series of 
  139.     wipe instructions.  For example "@r20" means wipe towards the 
  140.     right in 20 steps; and "@d20r20" means wipe downward in 20 steps
  141.     and within each step wipe right in 20 steps.  These combinations 
  142.     can get quiet complicated as shown in the included demo script.  
  143.        
  144.     The basic wipe instructions are as follows:
  145.                      
  146.        Rn    Wipe Right in <n> steps
  147.        Ln    Wipe Left in <n> steps
  148.        Dn    Wipe Down in <n> steps
  149.        Un    Wipe Up in <n> steps
  150.            
  151.       ARn    Alternate between wiping Right and Left in <n> steps,
  152.              starting with a wipe right. 
  153.       ALn    As above except starting with a Wipe Left,
  154.       AUn    Alternate between Up and Down wipes starting with Up.
  155.       ADn    As above except starting with Down.
  156.        
  157.       TRn    After each wipe, turn wipe direction 90 degrees counter-
  158.              clockwize (i.e. Right then Up then Left then Down then
  159.              Right ... ).  Start with wipe Right in <n> steps.
  160.       TLn    As above but start with wipe Left.       
  161.       TDn    As above but start with wipe Down.
  162.       TUn    As above but start with wipe Up.
  163.  
  164.       CRn    After each wipe, turn wipe direction 90 degrees clockwize 
  165.              (i.e. Right then Down then Left then Up then Right ... ).
  166.              Start with wipe Right in <n> steps.
  167.       CLn    As above but start with wipe Left.       
  168.       CDn    As above but start with wipe Down.
  169.       CUn    As above but start with wipe Up.
  170.           
  171.       IHn    Wipe inward from the sides (Horizontally).
  172.              Note:  this is actually done in n*2 steps.
  173.       IVn    Wipe inward from the top and bottom (Vertically).
  174.              Note: this is actually done in n*2 steps.
  175.       IAn    Wipe inward using <n> steps from all directions starting
  176.              with top and stepping clockwize.  Note:  takes n*4 steps.
  177.        In    Wipe inward in <n> steps.  Note:  This must be the last
  178.              instruction in wipe definition.
  179.  
  180.       OHn    Wipe outward to the sides (Horizontally).
  181.              Note:  this is actually done in n*2 steps.
  182.       OVn    Wipe outward to the top and bottom (Vertically) in <n>
  183.              steps.  Note this is actually done in n*2 steps.
  184.       OAn    Wipe outward using <n> steps from all directions starting
  185.              with top and stepping clockwize.  Note:  takes n*4 steps.
  186.        On    Wipe out from center in <n> steps.  Note:  This must be
  187.              the last instruction in wipe definition.
  188.                  
  189.  
  190.         ******************  Window Definitions  ******************
  191.     
  192.     XIP can restrict updating to a given area of a screen.  This is
  193.     done be specifying a window of the screen.  
  194.     
  195.     Window specification uses the format:
  196.     
  197.        (x,y,w,h)  Where:  X   is horizontal position, 
  198.                           Y   is vertical position, 
  199.                           W   is horizontal size of window, and
  200.                           H   is vertical size.  
  201.                          
  202.        Note:  if W or H is omitted or zero, then size is set to center
  203.               the window on the screen in accordance with the missing 
  204.               value.
  205.               
  206.  
  207.            ***************  Tiling Definition  ****************
  208.             
  209.     The current window may divided into sections which are updated
  210.     concurrently by specifying a tiling factor.  This is done using
  211.     the format:
  212.     
  213.        (H,V)  Where:  H  is the number horizontal sections.            
  214.                       V  in the number vertical sections 
  215.              
  216.               Notes:  If either H,V is zero that number is not changed
  217.                       from last setting.  [default if tiling off (1,1)]
  218.  
  219.         (S)   Where:  S  is the number of section horizontal and vertical
  220.  
  221.         ****************** XIP Control Commands *****************
  222.  
  223.     XIP commands are used to control various aspects of program operation
  224.     and screen control. 
  225.     
  226.     Double buffering will only when chip memory is available to do so. 
  227.     
  228.       -D   Disables double buffering  
  229.       +D   Enables double buffering [default]
  230.                         
  231.     The left mouse button is used for stopping a screen transition and
  232.     optionally control the presentation speed.                      
  233.  
  234.       -M   Disables mouse button control.
  235.       +M   Enables mouse button control. [default]
  236.  
  237.     The display speed can be regulated with the use of W command
  238.     
  239.       +Wn  Wait <n>/10th seconds between pictures         [default 40]
  240.       -Wn  Wait <n>/50th seconds between screen updates.  [default zero]
  241.  
  242.     The progress of the presentation can be monitored using the verbose (V)
  243.     control.  When activated it will display (to standard output) each 
  244.     parameter as it processed.
  245.                     
  246.       +V   Activate the parameter processing monitor
  247.       -V   Cancel the parameter processing monitor [default]
  248.       
  249.     When creating a command file you may find it helpful to use the 
  250.     test option in XIP.  When enabled, the command file lines are sent
  251.     to the standard output.  Then before each screen transition, the 
  252.     WorkBench screen is display and you are prompted to continue or not.
  253.     To display next screen, press return; to skip a number of breakpoints
  254.     press a corresponding number of spaces before pressing return.
  255.                
  256.        +T   Display each line processed in parameter file
  257.        -T   Suppress display of parameter [default]
  258.  
  259.     The current window can be made a solid color or the current colors
  260.     can be inverted with the use of the Color command (C). 
  261.     
  262.        +Cn  Fill the screen with color in register <n>.
  263.        -C   Inverts the color registers used in current window.
  264.        
  265.        
  266.         ***************  CLI Command Definition  *****************
  267.            
  268.     XIP is capable of executing CLI commands while during a processing.
  269.     The command is executed at the same time as the execution of XIP.
  270.  
  271.     Format: "=cmdline"  where cmdline is a CLI command with parameters.
  272.     
  273.                  Note:  If there is spaces in the command line enclose the
  274.                         command and the equal sign in quotes.
  275.                         
  276.                         
  277.         ***************   Command File Format   *****************
  278.            
  279.     XIP can be controlled by a command file.  This file can contain any
  280.     parameters that can be given on the CLI command line.  The file is
  281.     
  282.     Format:  "command comment" 
  283.     
  284.        command    an optional command which, if given, must start in 
  285.                   the first position and be one of the following:
  286.                      a process control command,
  287.                      a IFF picture (ILBM) filename,
  288.                      a XIP control filename, 
  289.                      a wipe definition, 
  290.                      a window definition, 
  291.                      a tiling definition, or
  292.                      a CLI command definition.
  293.        
  294.        comment    separate with a space from command.  If command contains
  295.                   spaces, i.e. filename, enclose the command in quotes (").
  296.                   If the first position of the line is a space the entire
  297.                   line is counted as a comment.
  298.  
  299.  
  300.         *********************  Distribution  *********************   
  301.  
  302.      This is freely-distributable, but copyrighted, program.   Without
  303.      written consent of the author, both the following restrictions must
  304.      be satisfied:
  305.      
  306.         *  All the following files are included, in their original
  307.            form as released by the author, with are contained on the
  308.        same diskette or included within a compressed archived file:
  309.            
  310.               XIP         This program, a image presentation program.
  311.               XIP.DOC     Documentation and example script file.
  312.               XIP.S       Command file for processing XIP.DOC
  313.               XIP.S.INFO  An icon for using ICONX on XIP.S
  314.               XIP.1       Demonstration Picture
  315.               XIP.2       Demonstration Picture
  316.               
  317.         *  No fee is charged other than diskette, duplication and handling
  318.        cost; or standard connection charges.  The total cost cannot be
  319.        over $10.
  320.            
  321.        
  322.            
  323.         ***************  XIP Command File Demo  ******************
  324.         
  325.    Note: the first two pictures are loaded in "Files ..." section.  
  326.  
  327. @r160       wipe right in 160 steps;      
  328. (1)         Update as single screen      
  329.  
  330. xip.1       Reload first picture
  331. @l20        Wipe left in 20 steps
  332. @r20        wipe right in 20 steps
  333. +w15        only wait a second and a half between pictures
  334.  
  335. -c          Complement Picture 
  336. @r20        Wipe down in 20 steps
  337. (2)         split screen in a 2x2 matrix   
  338.  
  339. -c1         Complement Picture Plane on only
  340. (5)         Split screen into 5x5 section
  341. @d5ar4      wipe down in 20 steps
  342.  
  343. XIP.2       Reload first picture
  344. (64)        Split by 64
  345. @al5        wipe left in 5 steps
  346.  
  347. -c2         Complement 2nd plane
  348.          
  349. -c1         complement colors
  350. (8,5)       make screen into 8x5 matrix
  351. @o4         go out in 4 steps
  352.  
  353. -c          complement colors          
  354. -w50        wait a second between draws
  355. (100)       Split by 100
  356. @d2         wipe down in 2 steps
  357.  
  358. -c                   
  359. (160)       Split by 160
  360. @r2         wipe right in 2 steps
  361.  
  362. +c
  363. (50)
  364. @d2
  365. -w0         no more step waits while drawing
  366.  
  367. (1,1)       Don't split screen
  368.  
  369. XIP.1
  370. @r32d20     Wipe right using 32 steps, within each step
  371.                 step wipe down in 20 steps
  372.  
  373. xip.2
  374. @d20ar32    Wipe down using 20 steps, within each step
  375.                  wipe alternating right (then left) in 20 steps
  376.  
  377. XIP.1
  378. @d5ar32ad4  Wipe down using 5 steps, within each step
  379.                  wipe alternating right (then left) in 32 steps, in those
  380.                       wipe alternating down (then left) in 4 steps
  381.                    
  382. XIP.2
  383. @u5ar8au2   Wipe up using 5 steps, within each step
  384.                  wipe alternating right (then left) in 8 steps, in those
  385.                       wipe alternating up (then down) in 2 steps
  386.                         
  387. -c          invert screen      
  388. @ih1ad2     in horizontal in 1 step, within each half 
  389.                  wipe alternate down then up 2 steps,  (Checker board)
  390.  
  391. -c1        invert screen first bit plane
  392. (1,1)      Stop Screen Splits
  393. @r20l10    Left wipe in a right wipe
  394.  
  395. XIP.1               
  396. @u2al2ad5al4ad5al8             Told you there were thousands of wipes!!!
  397.                                   this wipe makes 1200 different updates
  398.                                   to the screen.  Use wisely!!
  399. -c1           
  400. @ih20      In horizontal in 20 steps
  401.  
  402. -c2
  403. @iv5au20   In vertical in 5 steps, in each of the passed
  404.               alternate right (and left) with 20 steps
  405.  
  406. XIP.2                
  407. @ia20      Spiral in 20 bands 
  408.  
  409. -c1
  410. @ia5cr4    Spiral in 5 sweeps with 
  411.                4 steps in each direction
  412.  
  413. -c2
  414. @oa4cr10   Spiral out in 2 sweeps with
  415.               10 steps in each (4) direction
  416. -c
  417. (2)        Split in 2
  418. -c
  419. (8,5)      split in 4
  420.  
  421. xip.2
  422. @o20       Step out in 20 steps
  423.  
  424. XIP.1
  425. (1)        No Splits
  426. @oh10ov10  Out horizontally in 10 steps, with each step
  427.               step out vertically int 10 steps 
  428.               
  429. -c
  430. @iv10ih10  In vertically in 10 step out horizontally in 10 steps 
  431.  
  432. +c2        Color Drark grey
  433. @ih10ov10  in horizontally in 10 steps, with each step
  434.               step out vertically int 10 steps 
  435. -w0
  436.               
  437. xip.2
  438. @r10ih10   Step right 10 step out, with in horizontally 10 steps 
  439. -w15
  440.  
  441. -c   
  442. (2)        Split screep by 2 (horizontally and vertically)
  443. @i5        Step in 5 steps
  444.  
  445. xip.2
  446. (8,5)      Split Screen into 8 horizontal and 5 vertical 
  447. @o20       Step out in 2 steps
  448.  
  449. -c
  450. (32,20)    32x20 screen each area is (10x10) pixels
  451. @ih1       In using 1 step and within that step alterate down and up steps
  452.  
  453. -c
  454. (40,25)    40x25 screen matrix is (8x8) pixels
  455. @o4        outwards in 4 steps
  456.  
  457. -c
  458. -w50       wait a second between each step
  459. (80,50)    80x50 screen matrix is (4x4) pixels
  460. @r2        right in in two steps
  461. -w         turn wait off
  462.  
  463. xip.2
  464. (1,1)      Don't Divide screen
  465. (,,,)      Full screen
  466.  
  467.            **** now for window processing ****
  468.            
  469. (15,101,290,81)  Setup Window for updating:
  470.                     horizontal position (x) = 15
  471.                     vertical position   (y) = 101
  472.                     Window Width        (w) = 290
  473.                     Window Height       (h) = 81
  474.  
  475. xip.1      
  476. @          No wipe just pop on
  477.  
  478. -C         invert colors
  479.           
  480. xip.1      
  481. @r290      wipe right at single pixel pace;
  482.  
  483.  
  484. xip.2      
  485. @ad81      wipe down at single pixel pace;
  486.  
  487. +w0              No wait
  488. @o10             Wipe Out
  489. +C3              Fill with color three (LtGrey)
  490. +C1              Fill with color one   (White)
  491. (20,106,280,71)  Setup Window for updating:
  492. +C2              Fill with color two   (DkGrey)
  493. (25,111,270,61)  Setup Window for updating:
  494. +w10             Wait for a second
  495. +C0              Fill with color zero (Black)
  496. (30,116,260,51)  Setup Window for updating;
  497.  
  498. xip.2
  499. (15,101,290,81)  Setup Window for updating:
  500. @ih145     wipe in horizontall at single pixel pace;
  501.  
  502. -c         invert picture
  503. @ar29d27   Alternate right (then left)
  504.  
  505. -c1        invert picture first bit plane
  506.            Show as above window (don't forget it now a left wipe)
  507.  
  508. -c2
  509. @ov81      wipe out vertically in single pixel pace            
  510.  
  511. xip.1
  512. @i290      wipe in pixel at a time
  513.  
  514. -c        
  515. @o87       wipe out in 87 steps
  516.  
  517. -c1
  518. (10,3)     section window into 10 horizontal and 3 vertical sections 
  519. @o29       step out in 29 steps (single pixel)
  520.  
  521. -c2
  522. @ih29      in horizontal in single pixel steps (divided window)
  523.  
  524. xip.2
  525. @ov27      out vertically in single pixel steps (divided window)
  526.  
  527.  
  528.     ***** Example on how to make a presentation ****
  529.  
  530. (,,,)                       Full window
  531. (1)                         No Screen Splits                          
  532. +c                          Clear
  533.  
  534. +w5                         Only a half second wait, after this update.
  535. @u20                        wipe right quickly
  536. xip.1                       Load First Picture
  537. (60,0,216,75)               "XIP"
  538. @u20                        wipe left quickly
  539. +w10                        Wait a second after finished
  540. (46,78,239,19)              "Image Presentor"
  541. @u100
  542.  
  543. +w20                        Wait 2 seconds after this statement
  544. (0,186,320,13)              "Copyright 1988 ..." statement
  545. @r40                        wipe right in 40 steps
  546.  
  547. +w10                        wait a second between each feature
  548. (127,105,71,8)              "Features:"
  549. @oh20                       wipe out from center in 20 steps.
  550.  
  551. (24,117,132,10)             "Handles..."
  552. @r                          wipe right slowly
  553. (24,127,127,10)             "Thousands..."
  554. (24,137,103,10)             "Variable..."
  555. (24,147,55,10)              "Windowing"
  556.  
  557. +w1                         these next two are together no wait
  558. (24,157,86,8)               "Command ..."
  559. +w10                        Back to waiting a second
  560. (35,166,93,8)
  561.                
  562. (164,118,127,10)            "... Double ..." (Right side of list)
  563. +w0                         the next windows are together
  564. (164,128,129,9)             
  565. +w10                        
  566.  
  567. (176,137,82,10)             "... Non Interuptable ..."
  568.  
  569. (164,147,134,10)            "... IFF.library ..."
  570.  
  571. +w0                          
  572. (164,157,122,9)             "... $25 ..."
  573. +w10
  574. (176,166,120,10)
  575.  
  576. @i8                         in in eight tests
  577. (15,101,290,81)             put border on box
  578. +w50                        wait 10 seconds
  579.  
  580.      ***** exampe use of step delay -w ****
  581.  
  582. xip.1
  583. (1)                         No Splits
  584. -w50                        Take steps a second step intevals
  585. @i4                         Step inwards using 4 steps
  586. (,,,)                       Full Window                  
  587. +w30                        Wait 3 seconds
  588.  
  589.  
  590.      ***** slow spiral in to exit *****
  591.      
  592. +C         Clear Screen;
  593. -w         wait off
  594. +w10       wait a second after complete
  595. @ia20cr5   Wipe in max steps
  596.